home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 June / PCWorld_2007-06_cd.bin / temacd / wikipad / WikidPad-1.9beta2.exe / {app} / extensions / WikidPadHooks.py < prev    next >
Text File  |  2005-08-26  |  3KB  |  124 lines
  1. from os.path import join
  2.  
  3. WIKIDPAD_PLUGIN = (("hooks", 1),)
  4.  
  5. def startup(wikidPad):
  6.     """
  7.     Called when application starts
  8.     """
  9.  
  10.     pass
  11.  
  12. def newWiki(wikidPad, wikiName, wikiDir):
  13.     """
  14.     Called when a new wiki is about to be created.
  15.  
  16.     wikiName -- name of the wiki (already checked to be a proper CamelCase word)
  17.     wikiDir -- directory to create the wiki in (more precisely the .wiki config
  18.            file). This directory may already exist
  19.     """
  20.     pass
  21.  
  22. def createdWiki(wikidPad, wikiName, wikiDir):
  23.     """
  24.     Called when creation of a new wiki was done successfully.
  25.  
  26.     The home wiki word (equals name of the wiki) is not yet loaded.
  27.  
  28.     wikiName -- name of the wiki
  29.     wikiDir -- directory the wiki was created in
  30.     """
  31.     pass
  32.  
  33. def openWiki(wikidPad, wikiConfig):
  34.     """
  35.     Called when an existing wiki is about to be opened.
  36.  
  37.     wikiConfig -- path to the .wiki config file
  38.     """
  39.     pass
  40.  
  41. def openedWiki(wikidPad, wikiName, wikiConfig):
  42.     """
  43.     Called when an existing wiki was opened successfully
  44.  
  45.     wikiName -- name of the wiki
  46.     wikiConfig -- path to the .wiki config file
  47.     """
  48.     pass
  49.  
  50. def openWikiWord(wikidPad, wikiWord):
  51.     """
  52.     Called when a new or existing wiki word is about to be opened.
  53.     The previous active page is already saved, new one is not yet loaded.
  54.  
  55.     wikiWord -- name of the wiki word to open
  56.     """
  57.     pass
  58.  
  59. def newWikiWord(wikidPad, wikiWord):
  60.     """
  61.     Called when a new wiki word is about to be created.
  62.     The wikidPad.currentWikiPage of the new word is already available
  63.  
  64.     wikiWord -- name of the wiki word to create
  65.     """
  66.     pass
  67.  
  68. def openedWikiWord(wikidPad, wikiWord):
  69.     """
  70.     Called when a new or existing wiki word was opened successfully.
  71.  
  72.     wikiWord -- name of the wiki word to create
  73.     """
  74.     pass
  75.  
  76. def savingWikiWord(wikidPad, wikiWord):
  77.     """
  78.     Called when a new or existing wiki word is about to be saved
  79.  
  80.     wikiWord -- name of the wiki word to create
  81.     """
  82.     pass
  83.  
  84. def savedWikiWord(wikidPad, wikiWord):
  85.     """
  86.     Called when a wiki word was saved successfully
  87.  
  88.     wikiWord -- name of the wiki word to create
  89.     """
  90.     pass
  91.  
  92. def renamedWikiWord(wikidPad, fromWord, toWord):
  93.     """
  94.     Called when a wiki word was renamed successfully.
  95.  
  96.     The changed data is already saved in the fileset,
  97.     the GUI is not updated yet, the renamed page is not yet loaded.
  98.  
  99.     fromWord -- name of the wiki word before renaming
  100.     toWord -- name of the wiki word after renaming
  101.     """
  102.     pass
  103.  
  104. def deletedWikiWord(wikidPad, wikiWord):
  105.     """
  106.     Called when a wiki word was deleted successfully.
  107.  
  108.     The changed data is already saved in the fileset,
  109.     the GUI is not updated yet, another page (normally
  110.     the last in history before the deleted one) is not yet loaded.
  111.  
  112.     wikiWord -- name of the deleted wiki word
  113.     """
  114.     pass
  115.  
  116. def exit(wikidPad):
  117.     """
  118.     Called when the application is about to exit.
  119.  
  120.     The global and the wiki configuration (if any) are saved already,
  121.     the current wiki page (if any) is saved already.
  122.     """
  123.     pass
  124.